\nThis components allows to extend XSD field definition by providing a way to resolve simple type as\nexternal entity references.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.schema.ObjectResolverService", "descriptors": [ "org.nuxeo.ecm.core.schema.types.resolver.ObjectResolverDescriptor" ], "documentation": "\n\n Extension Point to register an external entity resolver. You must provide an XSD type derived from xs:string and\n registered under namespace http://www.nuxeo.org/ecm/schemas/core/external-references/. The resolver class must\n implement org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver.\n Example :\n\nExtension Point to register an external entity resolver. You must provide an XSD type derived from xs:string and\nregistered under namespace http://www.nuxeo.org/ecm/schemas/core/external-references/. The resolver class must\nimplement org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver.\nExample :\n\n
\nBy default, a constraint is added to documents about to be saved in order to validate if the property reference\nan existing external entity. You can disable this validation by setting attribute validation to false, for instance:\n\n\n\n\n\n\n
\n \n \n \n \n \n \nManage document types and schemas.\nAllows registrering new types defined using XSD schemas\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "descriptors": [ "org.nuxeo.ecm.core.schema.TypeConfiguration" ], "documentation": "\n Type manager configuration.\n \n\n This contains default prefetch options and clearComplexPropertyBeforeSet options. For example:\n\n \n common, dublincore \n true \n false \n \n\n\n Note that since 11.1, setting fields, such as dc:modified, as prefetch is DEPRECATED:\n only schema names are supported.\n\n Note that setting clearComplexPropertyBeforeSet to false is DEPRECATED since 9.3.\n Note that setting allowVersionWriteForDublinCore to true is DEPRECATED since 10.3.\n \n",
"documentationHtml": "\nType manager configuration.\n
\nThis contains default prefetch options and clearComplexPropertyBeforeSet options. For example:\n
<configuration>\n <prefetch>common, dublincore</prefetch>\n <clearComplexPropertyBeforeSet>true</clearComplexPropertyBeforeSet>\n <allowVersionWriteForDublinCore>false</allowVersionWriteForDublinCore>\n </configuration>\n\nNote that since 11.1, setting fields, such as dc:modified, as prefetch is DEPRECATED:\nonly schema names are supported.\n
\nNote that setting clearComplexPropertyBeforeSet to false is DEPRECATED since 9.3.\nNote that setting allowVersionWriteForDublinCore to true is DEPRECATED since 10.3.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/ExtensionPoints/org.nuxeo.ecm.core.schema.TypeService--configuration", "id": "org.nuxeo.ecm.core.schema.TypeService--configuration", "label": "configuration (org.nuxeo.ecm.core.schema.TypeService)", "name": "configuration", "version": "2021.66.4" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "descriptors": [ "org.nuxeo.ecm.core.schema.DocumentTypeDescriptor", "org.nuxeo.ecm.core.schema.FacetDescriptor", "org.nuxeo.ecm.core.schema.ProxiesDescriptor" ], "documentation": "\n Extension Point to register new document types and facets.\n \n\n Document types may implement several schemas and extends other\n document types. You can compare document types with java\n classes and schemas with java interfaces. Document types may\n also contains several facets that define a behavior.\n \n\n The prefetch element defines what fields are synchronously\n indexed, and are made available in search results listings.\n \n\n A doctype XML extension may contain several 'doctype' elements.\n A doctype element may look like this:\n\n\n \n \n \n \n \n \n \n dc:title, dc:modified, uid.uid \n \n\n\n\n Document types may also specify subtypes, which are sets of other\n document types that can be created inside the this document type\n being defined.\n \n\n This configuration only applies in the UI and will not affect\n documents created through APIs (e.g. REST, Java)\n This can be achieved as follows:\n\n \n \n \n File \n \n \n\n\n\n When extending a doctype, forbidden subtypes can also be specified\n to prevent a specific type from being created.\n \n\n This configuration only applies in the UI and will not affect\n documents created through APIs (e.g. REST, Java)\n\n \n \n \n SomeOtherFile \n \n \n File \n \n \n\n\n\n Facets are also defined by this extension point.\n They can have zero or more schemas:\n\n \n \n \n \n \n \n \n \n\n\n Queries using ecm:mixinType on facets marked with\n perDocumentQuery=\"false\" will not match any document where\n this facet has been added using DocumentModel.addFacet() and does\n not belong to the document type (this is done for performance reasons).\n\n Facets with enabled=false will be ignored in all document types\n still referencing them, and will not be returned when listing available facets.\n\n It's also possible to associate one or more schemas to all proxies:\n \n \n \n \n\n",
"documentationHtml": "\nExtension Point to register new document types and facets.\n
\nDocument types may implement several schemas and extends other\ndocument types. You can compare document types with java\nclasses and schemas with java interfaces. Document types may\nalso contains several facets that define a behavior.\n
\nThe prefetch element defines what fields are synchronously\nindexed, and are made available in search results listings.\n
\nA doctype XML extension may contain several 'doctype' elements.\nA doctype element may look like this:\n
\n
<doctype extends="Document" name="File">\n <schema name="common"/>\n <schema name="file"/>\n <schema name="dublincore"/>\n <schema name="uid"/>\n <facet name="Downloadable"/>\n <facet name="Versionable"/>\n <prefetch>dc:title, dc:modified, uid.uid</prefetch>\n </doctype>\n\nDocument types may also specify subtypes, which are sets of other\ndocument types that can be created inside the this document type\nbeing defined.\n
\nThis configuration only applies in the UI and will not affect\ndocuments created through APIs (e.g. REST, Java)\nThis can be achieved as follows:\n
\n
<doctype extends="Document" name="SomeFolder">\n <subtypes>\n <type>File</type>\n </subtypes>\n </doctype>\n\nWhen extending a doctype, forbidden subtypes can also be specified\nto prevent a specific type from being created.\n
\nThis configuration only applies in the UI and will not affect\ndocuments created through APIs (e.g. REST, Java)\n
\n
<doctype append="true" name="SomeFolder">\n <subtypes>\n <type>SomeOtherFile</type>\n </subtypes>\n <subtypes-forbidden>\n <type>File</type>\n </subtypes-forbidden>\n </doctype>\n\nFacets are also defined by this extension point.\nThey can have zero or more schemas:\n
\n
<facet name="MyFacet" perDocumentQuery="false"/>\n <facet name="MyFacetWithData">\n <schema name="myschema"/>\n <schema name="otherschema"/>\n </facet>\n <facet enabled="false" name="MyOldFacet"/>\n\nQueries using ecm:mixinType on facets marked with\nperDocumentQuery="false" will not match any document where\nthis facet has been added using DocumentModel.addFacet() and does\nnot belong to the document type (this is done for performance reasons).\n
\nFacets with enabled=false will be ignored in all document types\nstill referencing them, and will not be returned when listing available facets.\n
\nIt's also possible to associate one or more schemas to all proxies:\n
<proxies>\n <schema name="myschema"/>\n </proxies>\n\n \n \n \n\n The name\n attribute uniquely identify the schema, the src\n attribute specify\n the path to that schema (relative to the bundle root) and the prefix\n is used as\n a prefix (short name) of the schema namespace.\n The schema namespace is the targetNamespace defined inside the XSD file\n \n\n Note that multiple schemas can share the same target namespace and prefix\n \n\n You can also create a Nuxeo Schema from a sub part of the XSD schema.\n For that you can use the xsdRootElement attribute to indicate the complex type to use.\n \n \n \n\n A schema can be completely disabled with:\n \n \n \n\n Schemas with enabled=false will be ignored in all document types and facets\n still referencing them, and will not be returned when listing available schemas.\n\n Extension Point is also used to register additional property information, called property characteristic, such as:\n \n \n \n \n \n\n\n Properties declared with secured attribute can only be edited by administrators.\n \n\n Properties declared with deprecation attribute enable deprecation mechanism inside Nuxeo Platform.\n This generates WARN message of usage to help to remove deprecated usage.\n \n\n A contribution is one of these types:\n \n \n \n\n As it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\n This will also allows to import document declaring the removed property.\n \n",
"documentationHtml": "\nExtension Point to register new schemas.\n
\nSchemas are defined using XSD files.\nThe schema extension XML may containg several 'schema' objects as\nthe following ones:\n
<schema name="common" src="schema/common.xsd"/>\n <schema name="dublincore" prefix="dc" src="schema/dublincore.xsd"/>\n\nThe name\nattribute uniquely identify the schema, the src\nattribute specify\nthe path to that schema (relative to the bundle root) and the prefix\nis used as\na prefix (short name) of the schema namespace.\nThe schema namespace is the targetNamespace defined inside the XSD file\n
\nNote that multiple schemas can share the same target namespace and prefix\n
\nYou can also create a Nuxeo Schema from a sub part of the XSD schema.\nFor that you can use the xsdRootElement attribute to indicate the complex type to use.\n
<schema name="employeeSchema" src="schema/testExtension.xsd" xsdRootElement="employee"/>\n\nA schema can be completely disabled with:\n
<schema enabled="false" name="myOldSchema"/>\n\nSchemas with enabled=false will be ignored in all document types and facets\nstill referencing them, and will not be returned when listing available schemas.\n
\nExtension Point is also used to register additional property information, called property characteristic, such as:\n
\nXML extensions may contain any number of 'property' elements of the form:\n
<property name="creator" schema="dublincore" secured="true"/>\n <property deprecation="deprecated" name="size" schema="common"/>\n <property deprecation="removed" fallback="content/name"\n name="filename" schema="file"/>\n\nProperties declared with secured attribute can only be edited by administrators.\n
\nProperties declared with deprecation attribute enable deprecation mechanism inside Nuxeo Platform.\nThis generates WARN message of usage to help to remove deprecated usage.\n
\nA contribution is one of these types:\n
\nThe fallback attribute is optional, its value has to be a xpath referencing an existing property in the same\nschema than deprecated/removed property.\nWhen presents, it is used:\n
\nNote: for a deprecated property, setValue also set value to property and getValue get value from property if\nfallback value is null.\n
\nFor example, the contribution below enables WARN message of usage of property file:filename\n. This will also\nget/set the value from/to file:content/name\nfor deprecated usage of file:filename\nproperty.\n
<property deprecation="deprecated" fallback="content/name"\n name="filename" schema="file"/>\n\nAs it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\nThis will also allows to import document declaring the removed property.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/ExtensionPoints/org.nuxeo.ecm.core.schema.TypeService--schema", "id": "org.nuxeo.ecm.core.schema.TypeService--schema", "label": "schema (org.nuxeo.ecm.core.schema.TypeService)", "name": "schema", "version": "2021.66.4" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "descriptors": [ "org.nuxeo.ecm.core.schema.PropertyDeprecationDescriptor" ], "documentation": "\n Extension Point to register deprecated/removed properties.\n XML extensions may contain any number of 'property' elements of the form:\n\n \n \n \n\n A property contributed to this extension point enables deprecation mechanisms inside Nuxeo Platform.\n This generates WARN message of usage to help to remove deprecated usage.\n \n\n A contribution is one of these types:\n \n \n \n\n As it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\n This will also allows to import document declaring the removed property.\n \n\n @since 9.2\n @deprecated since 11.1, use schema extension point with PropertyDescriptor object\n \n",
"documentationHtml": "\nExtension Point to register deprecated/removed properties.\nXML extensions may contain any number of 'property' elements of the form:\n
<property deprecated="true" name="size" schema="common"/>\n <property fallback="content/name" name="filename" schema="file"/>\n\nA property contributed to this extension point enables deprecation mechanisms inside Nuxeo Platform.\nThis generates WARN message of usage to help to remove deprecated usage.\n
\nA contribution is one of these types:\n
\nThe fallback attribute is optional, its value has to be a xpath referencing an existing property in the same\nschema than removed/deprecated property.\nWhen presents, it is used:\n
\nNote: for a deprecated property, setValue also set value to property and getValue get value from property if\nfallback value is null.\n
\nFor example, the contribution below enables WARN message of usage of property file:filename\n. This will also\nget/set the value from/to file:content/name\nfor deprecated usage of file:filename\nproperty.\n
<property fallback="content/name" name="filename" schema="file"/>\n\nAs it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\nThis will also allows to import document declaring the removed property.\n
\n@since 9.2\n@deprecated since 11.1, use schema extension point with PropertyDescriptor object\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/ExtensionPoints/org.nuxeo.ecm.core.schema.TypeService--deprecation", "id": "org.nuxeo.ecm.core.schema.TypeService--deprecation", "label": "deprecation (org.nuxeo.ecm.core.schema.TypeService)", "name": "deprecation", "version": "2021.66.4" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService", "name": "org.nuxeo.ecm.core.schema.TypeService", "requirements": [ "org.nuxeo.ecm.core.schema.ObjectResolverService" ], "resolutionOrder": 159, "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/Services/org.nuxeo.ecm.core.schema.SchemaManager", "id": "org.nuxeo.ecm.core.schema.SchemaManager", "overriden": false, "version": "2021.66.4" }, { "@type": "NXService", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/Services/org.nuxeo.ecm.core.schema.TypeProvider", "id": "org.nuxeo.ecm.core.schema.TypeProvider", "overriden": false, "version": "2021.66.4" }, { "@type": "NXService", "componentId": "org.nuxeo.ecm.core.schema.TypeService", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.schema/org.nuxeo.ecm.core.schema.TypeService/Services/org.nuxeo.ecm.core.schema.PropertyCharacteristicHandler", "id": "org.nuxeo.ecm.core.schema.PropertyCharacteristicHandler", "overriden": false, "version": "2021.66.4" } ], "startOrder": 15, "version": "2021.66.4", "xmlFileContent": "\n\n \n common, dublincore \n true \n false \n \n \n Note that since 11.1, setting fields, such as dc:modified, as prefetch is DEPRECATED:\n only schema names are supported.\n\n Note that setting clearComplexPropertyBeforeSet to false is DEPRECATED since 9.3.\n Note that setting allowVersionWriteForDublinCore to true is DEPRECATED since 10.3.\n \n \n dc:title, dc:modified, uid.uid \n \n \n\n Document types may also specify subtypes, which are sets of other\n document types that can be created inside the this document type\n being defined.\n \n This configuration only applies in the UI and will not affect\n documents created through APIs (e.g. REST, Java)\n This can be achieved as follows:\n\n \n \n \n File \n \n \n \n\n When extending a doctype, forbidden subtypes can also be specified\n to prevent a specific type from being created.\n \n This configuration only applies in the UI and will not affect\n documents created through APIs (e.g. REST, Java)\n\n \n \n \n SomeOtherFile \n \n \n File \n \n \n \n\n Facets are also defined by this extension point.\n They can have zero or more schemas:\n\n \n \n \n \n\n Queries using ecm:mixinType on facets marked with\n perDocumentQuery=\"false\" will not match any document where\n this facet has been added using DocumentModel.addFacet() and does\n not belong to the document type (this is done for performance reasons).\n\n Facets with enabled=false will be ignored in all document types\n still referencing them, and will not be returned when listing available facets.\n\n It's also possible to associate one or more schemas to all proxies:\n \n \n \n \n \n \n The name attribute uniquely identify the schema, the src attribute specify\n the path to that schema (relative to the bundle root) and the prefix is used as\n a prefix (short name) of the schema namespace.\n The schema namespace is the targetNamespace defined inside the XSD file\n \n Note that multiple schemas can share the same target namespace and prefix\n \n You can also create a Nuxeo Schema from a sub part of the XSD schema.\n For that you can use the xsdRootElement attribute to indicate the complex type to use.\n \n \n A schema can be completely disabled with:\n \n \n Schemas with enabled=false will be ignored in all document types and facets\n still referencing them, and will not be returned when listing available schemas.\n\n Extension Point is also used to register additional property information, called property characteristic, such as:\n \n \n\n Properties declared with secured attribute can only be edited by administrators.\n \n Properties declared with deprecation attribute enable deprecation mechanism inside Nuxeo Platform.\n This generates WARN message of usage to help to remove deprecated usage.\n \n A contribution is one of these types:\n \n \n As it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\n This will also allows to import document declaring the removed property.\n \n \n A property contributed to this extension point enables deprecation mechanisms inside Nuxeo Platform.\n This generates WARN message of usage to help to remove deprecated usage.\n \n A contribution is one of these types:\n \n \n As it, each usage of this property will automatically fallback on the fallback and avoid exception from platform.\n This will also allows to import document declaring the removed property.\n \n @since 9.2\n @deprecated since 11.1, use schema extension point with PropertyDescriptor object\n